Skip to main content

Create Shipping Fee Rate Card

POST /orders/shipping/rate-cards

Description

Create shipping fee rate card based on the weight and distance bands. This endpoint allows you to define the shipping rates for different weight and distance ranges.

Parameters

  • tenantId (string, header, required): The ID of the tenant.
  • countryCode (string, header, required): The country code.

Request Body

  • Media Type: application/json

Example Value

{
"shippingFeeRateCardRequestDtoList": [
{
"lowerWeightBand": 0,
"higherWeightBand": 1,
"lowerDistanceBand": 0,
"higherDistanceBand": 1,
"amount": 1,
"measurementUnitDistance": "string",
"measurementUnitWeight": "string",
"rateType": "string",
"capAmount": 1
}
]
}

Responses

This section outlines the possible responses from the create shipping fee rate card API.

Success Response (200)

The Success Response (200) is returned when the shipping fee rate card is successfully created. This response indicates the success of the operation and provides additional details.

Response Fields

FieldTypeDescription
statusbooleanIndicates the success of the shipping fee rate card creation request.
statusCodeintegerNumeric code representing the status of the response (e.g., 0 for success).
messagestringA message indicating the outcome of the operation.
dataobjectContains the created shipping fee rate card details.
errorsarrayAn array of objects providing details about any errors encountered during the request.

Example

JSON:

{
"status": true,
"statusCode": 0,
"message": "shipping fee rate card creation successful",
"data": {},
"errors": [
{
"message": "string",
"descriptiveMessage": "string"
}
]
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request POST \ 
--url /orders/shipping/rate-cards \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!